home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.1 / readline.1 < prev    next >
Text File  |  1995-07-25  |  70KB  |  1,123 lines

  1.  
  2.  
  3.  
  4.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           readline - get a line from a user with editing
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<rrrreeeeaaaaddddlllliiiinnnneeee....hhhh>>>>
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<hhhhiiiissssttttoooorrrryyyy....hhhh>>>>
  14.  
  15.           ttttyyyyppppeeeeddddeeeeffff iiiinnnntttt FFFFuuuunnnnccccttttiiiioooonnnn (((())));;;;
  16.  
  17.           cccchhhhaaaarrrr ****rrrreeeeaaaaddddlllliiiinnnneeee ((((pppprrrroooommmmpppptttt))))
  18.           cccchhhhaaaarrrr ****pppprrrroooommmmpppptttt;;;;
  19.  
  20.           iiiinnnntttt rrrrllll____aaaadddddddd____ddddeeeeffffuuuunnnn ((((nnnnaaaammmmeeee,,,, ffffuuuunnnnccccttttiiiioooonnnn,,,, kkkkeeeeyyyy))))
  21.           cccchhhhaaaarrrr ****nnnnaaaammmmeeee;;;;
  22.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  23.           iiiinnnntttt kkkkeeeeyyyy;;;;
  24.  
  25.           iiiinnnntttt rrrrllll____bbbbiiiinnnndddd____kkkkeeeeyyyy ((((kkkkeeeeyyyy,,,, ffffuuuunnnnccccttttiiiioooonnnn))))
  26.           iiiinnnntttt kkkkeeeeyyyy;;;;
  27.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  28.  
  29.           iiiinnnntttt rrrrllll____uuuunnnnbbbbiiiinnnndddd____kkkkeeeeyyyy ((((kkkkeeeeyyyy))))
  30.           iiiinnnntttt kkkkeeeeyyyy;;;;
  31.  
  32.           iiiinnnntttt rrrrllll____bbbbiiiinnnndddd____kkkkeeeeyyyy____iiiinnnn____mmmmaaaapppp ((((kkkkeeeeyyyy,,,, ffffuuuunnnnccccttttiiiioooonnnn,,,, kkkkeeeeyyyymmmmaaaapppp))))
  33.           iiiinnnntttt kkkkeeeeyyyy;;;;
  34.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  35.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  36.  
  37.           iiiinnnntttt rrrrllll____uuuunnnnbbbbiiiinnnndddd____kkkkeeeeyyyy____iiiinnnn____mmmmaaaapppp ((((kkkkeeeeyyyy,,,, kkkkeeeeyyyymmmmaaaapppp))))
  38.           iiiinnnntttt kkkkeeeeyyyy;;;;
  39.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  40.           iiiinnnntttt rrrrllll____mmmmaaaaccccrrrroooo____bbbbiiiinnnndddd ((((kkkkeeeeyyyysssseeeeqqqq,,,, mmmmaaaaccccrrrroooo,,,, kkkkeeeeyyyymmmmaaaapppp)))) cccchhhhaaaarrrr ****kkkkeeeeyyyysssseeeeqqqq,,,,
  41.           ****mmmmaaaaccccrrrroooo;;;; KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  42.  
  43.           iiiinnnntttt rrrrllll____vvvvaaaarrrriiiiaaaabbbblllleeee____bbbbiiiinnnndddd ((((vvvvaaaarrrriiiiaaaabbbblllleeee,,,, vvvvaaaalllluuuueeee))))
  44.           cccchhhhaaaarrrr ****vvvvaaaarrrriiiiaaaabbbblllleeee,,,, ****vvvvaaaalllluuuueeee;;;;
  45.  
  46.           iiiinnnntttt rrrrllll____ppppaaaarrrrsssseeee____aaaannnndddd____bbbbiiiinnnndddd ((((lllliiiinnnneeee))))
  47.           cccchhhhaaaarrrr ****lllliiiinnnneeee;;;;
  48.  
  49.           iiiinnnntttt rrrrllll____ttttrrrraaaannnnssssllllaaaatttteeee____kkkkeeeeyyyysssseeeeqqqq ((((kkkkeeeeyyyysssseeeeqqqq,,,, aaaarrrrrrrraaaayyyy,,,, lllleeeennnn))))
  50.           cccchhhhaaaarrrr ****kkkkeeeeyyyysssseeeeqqqq,,,, ****aaaarrrrrrrraaaayyyy;;;;
  51.           iiiinnnntttt ****lllleeeennnn;;;;
  52.  
  53.           FFFFuuuunnnnccccttttiiiioooonnnn ****rrrrllll____nnnnaaaammmmeeeedddd____ffffuuuunnnnccccttttiiiioooonnnn ((((ccccoooommmmmmmmaaaannnndddd))))
  54.           cccchhhhaaaarrrr ****ccccoooommmmmmmmaaaannnndddd;;;;
  55.  
  56.           FFFFuuuunnnnccccttttiiiioooonnnn ****rrrrllll____ffffuuuunnnnccccttttiiiioooonnnn____ooooffff____kkkkeeeeyyyysssseeeeqqqq ((((kkkkeeeeyyyysssseeeeqqqq,,,, kkkkeeeeyyyymmmmaaaapppp,,,, ttttyyyyppppeeee))))
  57.           cccchhhhaaaarrrr ****kkkkeeeeyyyysssseeeeqqqq;;;;
  58.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  59.           iiiinnnntttt ****ttttyyyyppppeeee;;;;
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 6/30/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  71.  
  72.  
  73.  
  74.           cccchhhhaaaarrrr ********rrrrllll____iiiinnnnvvvvooookkkkiiiinnnngggg____kkkkeeeeyyyysssseeeeqqqqssss ((((ffffuuuunnnnccccttttiiiioooonnnn))))
  75.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  76.  
  77.           cccchhhhaaaarrrr ********rrrrllll____iiiinnnnvvvvooookkkkiiiinnnngggg____kkkkeeeeyyyysssseeeeqqqqssss____iiiinnnn____mmmmaaaapppp ((((ffffuuuunnnnccccttttiiiioooonnnn,,,, kkkkeeeeyyyymmmmaaaapppp))))
  78.           FFFFuuuunnnnccccttttiiiioooonnnn ****ffffuuuunnnnccccttttiiiioooonnnn;;;;
  79.           KKKKeeeeyyyymmmmaaaapppp kkkkeeeeyyyymmmmaaaapppp;;;;
  80.  
  81.           vvvvooooiiiidddd rrrrllll____ffffuuuunnnnccccttttiiiioooonnnn____dddduuuummmmppppeeeerrrr ((((rrrreeeeaaaaddddaaaabbbblllleeee))))
  82.           iiiinnnntttt rrrreeeeaaaaddddaaaabbbblllleeee;;;;
  83.  
  84.           cccchhhhaaaarrrr ********rrrrllll____ffffuuuunnnnmmmmaaaapppp____nnnnaaaammmmeeeessss (((())))
  85.  
  86.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  87.           Readline is Copyright (C) 1989, 1991 by the Free Software
  88.           Foundation, Inc.
  89.  
  90.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  91.           rrrreeeeaaaaddddlllliiiinnnneeee will read a line from the terminal and return it,
  92.           using pppprrrroooommmmpppptttt as a prompt.  If pppprrrroooommmmpppptttt is null, no prompt is
  93.           issued.  The line returned is allocated with _m_a_l_l_o_c(3), so
  94.           the caller must free it when finished.  The line returned
  95.           has the final newline removed, so only the text of the line
  96.           remains.
  97.  
  98.           rrrreeeeaaaaddddlllliiiinnnneeee offers editing capabilities while the user is
  99.           entering the line.  By default, the line editing commands
  100.           are similar to those of emacs.  A vi-style line editing
  101.           interface is also available.
  102.  
  103.           In the following descriptions, kkkkeeeeyyyymmmmaaaapppp can be one of
  104.           _e_m_a_c_s__k_e_y_m_a_p, _e_m_a_c_s__m_e_t_a__k_e_y_m_a_p, _e_m_a_c_s__c_t_l_x__k_e_y_m_a_p,
  105.           _v_i__i_n_s_e_r_t_i_o_n__k_e_y_m_a_p, _o_r _v_i__m_o_v_e_m_e_n_t__k_e_y_m_a_p.
  106.  
  107.           rrrrllll____aaaadddddddd____ddddeeeeffffuuuunnnn makes nnnnaaaammmmeeee appear as a bindable readline
  108.           command, and makes ffffuuuunnnnccccttttiiiioooonnnn be the function called when that
  109.           command is invoked.  If kkkkeeeeyyyy is not -1, it is bound to
  110.           ffffuuuunnnnccccttttiiiioooonnnn in the current keymap.
  111.  
  112.           rrrrllll____bbbbiiiinnnndddd____kkkkeeeeyyyy causes kkkkeeeeyyyy to invoke ffffuuuunnnnccccttttiiiioooonnnn.  The binding is
  113.           made in the current keymap.
  114.  
  115.           rrrrllll____uuuunnnnbbbbiiiinnnndddd____kkkkeeeeyyyy removes the binding for kkkkeeeeyyyy in the current
  116.           keymap.
  117.  
  118.           rrrrllll____bbbbiiiinnnndddd____kkkkeeeeyyyy____iiiinnnn____mmmmaaaapppp makes the kkkkeeeeyyyy entry in kkkkeeeeyyyymmmmaaaapppp invoke
  119.           ffffuuuunnnnccccttttiiiioooonnnn.
  120.  
  121.           rrrrllll____uuuunnnnbbbbiiiinnnndddd____kkkkeeeeyyyy____iiiinnnn____mmmmaaaapppp removes the binding for kkkkeeeeyyyy in keymap
  122.           kkkkeeeeyyyymmmmaaaapppp.
  123.  
  124.           rrrrllll____mmmmaaaaccccrrrroooo____bbbbiiiinnnndddd makes kkkkeeeeyyyysssseeeeqqqq insert the string mmmmaaaaccccrrrroooo.  The
  125.           binding is performed in kkkkeeeeyyyymmmmaaaapppp.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 6/30/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  137.  
  138.  
  139.  
  140.           rrrrllll____vvvvaaaarrrriiiiaaaabbbblllleeee____bbbbiiiinnnndddd sets the value of the readline variable
  141.           vvvvaaaarrrriiiiaaaabbbblllleeee to vvvvaaaalllluuuueeee.
  142.  
  143.           rrrrllll____ppppaaaarrrrsssseeee____aaaannnndddd____bbbbiiiinnnndddd takes as an argument a line of the same
  144.           form as the readline startup file (see IIIINNNNIIIITTTTIIIIAAAALLLLIIIIZZZZAAAATTTTIIIIOOOONNNN FFFFIIIILLLLEEEE
  145.           below) and executes the commands therein.
  146.  
  147.           rrrrllll____ttttrrrraaaannnnssssllllaaaatttteeee____kkkkeeeeyyyysssseeeeqqqq converts kkkkeeeeyyyysssseeeeqqqq into a new string,
  148.           storing the result in aaaarrrrrrrraaaayyyy.  This translates control and
  149.           meta prefixes and the readline character escape sequences
  150.           (see KKKKeeeeyyyy BBBBiiiinnnnddddiiiinnnnggggssss below).  The length of the translated
  151.           sequence is returned in ****lllleeeennnn.
  152.  
  153.           rrrrllll____nnnnaaaammmmeeeedddd____ffffuuuunnnnccccttttiiiioooonnnn returns the function that is executed when
  154.           the readline command ccccoooommmmmmmmaaaannnndddd is invoked.
  155.  
  156.           rrrrllll____ffffuuuunnnnccccttttiiiioooonnnn____ooooffff____kkkkeeeeyyyysssseeeeqqqq returns the function that is executed
  157.           when kkkkeeeeyyyysssseeeeqqqq is read and kkkkeeeeyyyymmmmaaaapppp is the current keymap.  ttttyyyyppppeeee
  158.           is set to indicate whether the return value corresponds to a
  159.           function, macro, or auxiliary keymap.
  160.  
  161.           rrrrllll____iiiinnnnvvvvooookkkkiiiinnnngggg____kkkkeeeeyyyysssseeeeqqqqssss returns all of the key sequences in the
  162.           current keymap that invoke ffffuuuunnnnccccttttiiiioooonnnn.
  163.  
  164.           rrrrllll____iiiinnnnvvvvooookkkkiiiinnnngggg____kkkkeeeeyyyysssseeeeqqqqssss____iiiinnnn____mmmmaaaapppp returns all of the key sequences
  165.           in kkkkeeeeyyyymmmmaaaapppp that invoke ffffuuuunnnnccccttttiiiioooonnnn.
  166.  
  167.           rrrrllll____ffffuuuunnnnccccttttiiiioooonnnn____dddduuuummmmppppeeeerrrr prints all of the readline functions and
  168.           their bindings to the readline output stream.  If rrrreeeeaaaaddddaaaabbbblllleeee
  169.           is non-zero, the output is formattted so that it can be read
  170.           back in to restore the bindings.
  171.  
  172.           rrrrllll____ffffuuuunnnnmmmmaaaapppp____nnnnaaaammmmeeeessss returns an array of all known readline
  173.           bindable function names.  The array is sorted.
  174.  
  175.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  176.           rrrreeeeaaaaddddlllliiiinnnneeee returns the text of the line read.  A blank line
  177.           returns the empty string.  If EEEEOOOOFFFF is encountered while
  178.           reading a line, and the line is empty, NNNNUUUULLLLLLLL is returned.  If
  179.           an EEEEOOOOFFFF is read with a non-empty line, it is treated as a
  180.           newline.
  181.  
  182.           Unless otherwise stated, the other functions return 0 on
  183.           success and non-zero on failure.
  184.  
  185.      NNNNOOOOTTTTAAAATTTTIIIIOOOONNNN
  186.           An emacs-style notation is used to denote keystrokes.
  187.           Control keys are denoted by C-_k_e_y, e.g., C-n means
  188.           Control-N.  Similarly, _m_e_t_a keys are denoted by M-_k_e_y, so
  189.           M-x means Meta-X.  (On keyboards without a _m_e_t_a key, M-_x
  190.           means ESC _x, i.e., press the Escape key then the _x key.
  191.           This makes ESC the _m_e_t_a _p_r_e_f_i_x.  The combination M-C-_x means
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 6/30/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  203.  
  204.  
  205.  
  206.           ESC-Control-_x, or press the Escape key then hold the Control
  207.           key while pressing the _x key.)
  208.  
  209.           Readline commands may be given numeric _a_r_g_u_m_e_n_t_s, which
  210.           normally act as a repeat count.  Sometimes, however, it is
  211.           the sign of the argument that is significant.  Passing a
  212.           negative argument to a command that acts in the forward
  213.           direction (e.g., kkkkiiiillllllll----lllliiiinnnneeee) causes that command to act in a
  214.           backward direction.  Commands whose behavior with arguments
  215.           deviates from this are noted.
  216.  
  217.           When a command is described as _k_i_l_l_i_n_g text, the text
  218.           deleted is saved for possible future retrieval (_y_a_n_k_i_n_g).
  219.           The killed text is saved in a _k_i_l_l-_r_i_n_g.  Consecutive kills
  220.           cause the text to be accumulated into one unit, which can be
  221.           yanked all at once. Commands which do not kill text separate
  222.           the chunks of text on the kill-ring.
  223.  
  224.      IIIINNNNIIIITTTTIIIIAAAALLLLIIIIZZZZAAAATTTTIIIIOOOONNNN FFFFIIIILLLLEEEE
  225.           Readline is customized by putting commands in an
  226.           initialization file.  The name of this file is taken from
  227.           the value of the IIIINNNNPPPPUUUUTTTTRRRRCCCC variable.  If that variable is
  228.           unset, the default is ~/._i_n_p_u_t_r_c.  When a program which uses
  229.           the readline library starts up, the init file is read, and
  230.           the key bindings and variables are set.  There are only a
  231.           few basic constructs allowed in the readline init file.
  232.           Blank lines are ignored.  Lines beginning with a #### are
  233.           comments.  Lines beginning with a $$$$ indicate conditional
  234.           constructs.  Other lines denote key bindings and variable
  235.           settings.  Each program using this library may add its own
  236.           commands and bindings.
  237.  
  238.           For example, placing
  239.  
  240.                M-Control-u: universal-argument
  241.           or
  242.                C-Meta-u: universal-argument
  243.           into the ~/._i_n_p_u_t_r_c would make M-C-u execute the readline
  244.           command _u_n_i_v_e_r_s_a_l-_a_r_g_u_m_e_n_t.
  245.  
  246.           The following symbolic character names are recognized while
  247.           processing key bindings: _R_U_B_O_U_T, _D_E_L, _E_S_C, _L_F_D, _N_E_W_L_I_N_E,
  248.           _R_E_T, _R_E_T_U_R_N, _S_P_C, _S_P_A_C_E, and _T_A_B.  In addition to command
  249.           names, readline allows keys to be bound to a string that is
  250.           inserted when the key is pressed (a _m_a_c_r_o).
  251.  
  252.         KKKKeeeeyyyy BBBBiiiinnnnddddiiiinnnnggggssss
  253.           The syntax for controlling key bindings in the ~/._i_n_p_u_t_r_c
  254.           file is simple.  All that is required is the name of the
  255.           command or the text of a macro and a key sequence to which
  256.           it should be bound. The name may be specified in one of two
  257.           ways: as a symbolic key name, possibly with _M_e_t_a- or
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 6/30/95)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  269.  
  270.  
  271.  
  272.           _C_o_n_t_r_o_l- prefixes, or as a key sequence.  When using the
  273.           form kkkkeeeeyyyynnnnaaaammmmeeee:_f_u_n_c_t_i_o_n-_n_a_m_e or _m_a_c_r_o, _k_e_y_n_a_m_e is the name of
  274.           a key spelled out in English.  For example:
  275.  
  276.                Control-u: universal-argument
  277.                Meta-Rubout: backward-kill-word
  278.                Control-o: ">&output"
  279.  
  280.           In the above example, _C-_u is bound to the function
  281.           uuuunnnniiiivvvveeeerrrrssssaaaallll----aaaarrrrgggguuuummmmeeeennnntttt, _M-_D_E_L is bound to the function
  282.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----kkkkiiiillllllll----wwwwoooorrrrdddd, and _C-_o is bound to run the macro
  283.           expressed on the right hand side (that is, to insert the
  284.           text >&_o_u_t_p_u_t into the line).
  285.  
  286.           In the second form, """"kkkkeeeeyyyysssseeeeqqqq"""":_f_u_n_c_t_i_o_n-_n_a_m_e or _m_a_c_r_o, kkkkeeeeyyyysssseeeeqqqq
  287.           differs from kkkkeeeeyyyynnnnaaaammmmeeee above in that strings denoting an
  288.           entire key sequence may be specified by placing the sequence
  289.           within double quotes.  Some GNU Emacs style key escapes can
  290.           be used, as in the following example.
  291.  
  292.                "\C-u": universal-argument
  293.                "\C-x\C-r": re-read-init-file
  294.                "\e[11~": "Function Key 1"
  295.  
  296.           In this example, _C-_u is again bound to the function
  297.           uuuunnnniiiivvvveeeerrrrssssaaaallll----aaaarrrrgggguuuummmmeeeennnntttt.  _C-_x _C-_r is bound to the function
  298.           rrrreeee----rrrreeeeaaaadddd----iiiinnnniiiitttt----ffffiiiilllleeee, and _E_S_C [ _1 _1 ~ is bound to insert the
  299.           text FFFFuuuunnnnccccttttiiiioooonnnn KKKKeeeeyyyy 1111.  The full set of escape sequences is
  300.  
  301.                \\\\CCCC----  control prefix
  302.  
  303.                \\\\MMMM----  meta prefix
  304.  
  305.                \\\\eeee   an escape character
  306.  
  307.                \\\\\\\\   backslash
  308.  
  309.                \\\\""""   literal "
  310.  
  311.                \\\\''''   literal '
  312.  
  313.           When entering the text of a macro, single or double quotes
  314.           should be used to indicate a macro definition.  Unquoted
  315.           text is assumed to be a function name.  Backslash will quote
  316.           any character in the macro text, including " and '.
  317.  
  318.           BBBBaaaasssshhhh allows the current readline key bindings to be
  319.           displayed or modified with the bbbbiiiinnnndddd builtin command.  The
  320.           editing mode may be switched during interactive use by using
  321.           the ----oooo option to the sssseeeetttt builtin command.  Other programs
  322.           using this library provide similar mechanisms.  The _i_n_p_u_t_r_c
  323.           file may be edited and re-read if a program does not provide
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 6/30/95)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  335.  
  336.  
  337.  
  338.           any other means to incorporate new bindings.
  339.  
  340.         VVVVaaaarrrriiiiaaaabbbblllleeeessss
  341.           Readline has variables that can be used to further customize
  342.           its behavior.  A variable may be set in the _i_n_p_u_t_r_c file
  343.           with a statement of the form
  344.  
  345.                sssseeeetttt _v_a_r_i_a_b_l_e-_n_a_m_e _v_a_l_u_e
  346.  
  347.           Except where noted, readline variables can take the values
  348.           OOOOnnnn or OOOOffffffff.  The variables and their default values are:
  349.  
  350.           hhhhoooorrrriiiizzzzoooonnnnttttaaaallll----ssssccccrrrroooollllllll----mmmmooooddddeeee ((((OOOOffffffff))))
  351.                When set to OOOOnnnn, makes readline use a single line for
  352.                display, scrolling the input horizontally on a single
  353.                screen line when it becomes longer than the screen
  354.                width rather than wrapping to a new line.
  355.           eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee ((((eeeemmmmaaaaccccssss))))
  356.                Controls whether readline begins with a set of key
  357.                bindings similar to _e_m_a_c_s or _v_i.  eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee can be
  358.                set to either eeeemmmmaaaaccccssss or vvvviiii.
  359.           mmmmaaaarrrrkkkk----mmmmooooddddiiiiffffiiiieeeedddd----lllliiiinnnneeeessss ((((OOOOffffffff))))
  360.                If set to OOOOnnnn, history lines that have been modified are
  361.                displayed with a preceding asterisk (****).
  362.           bbbbeeeellllllll----ssssttttyyyylllleeee ((((aaaauuuuddddiiiibbbblllleeee))))
  363.                Controls what happens when readline wants to ring the
  364.                terminal bell.  If set to nnnnoooonnnneeee, readline never rings
  365.                the bell.  If set to vvvviiiissssiiiibbbblllleeee, readline uses a visible
  366.                bell if one is available.  If set to aaaauuuuddddiiiibbbblllleeee, readline
  367.                attempts to ring the terminal's bell.
  368.           ccccoooommmmmmmmeeeennnntttt----bbbbeeeeggggiiiinnnn ((((````````####''''''''))))
  369.                The string that is inserted in vvvviiii mode when the
  370.                vvvviiii----ccccoooommmmmmmmeeeennnntttt command is executed.
  371.           mmmmeeeettttaaaa----ffffllllaaaagggg ((((OOOOffffffff))))
  372.                If set to OOOOnnnn, readline will enable eight-bit input
  373.                (that is, it will not strip the high bit from the
  374.                characters it reads), regardless of what the terminal
  375.                claims it can support.
  376.           ccccoooonnnnvvvveeeerrrrtttt----mmmmeeeettttaaaa ((((OOOOnnnn))))
  377.                If set to OOOOnnnn, readline will convert characters with the
  378.                eighth bit set to an ASCII key sequence by stripping
  379.                the eighth bit and prepending an escape character (in
  380.                effect, using escape as the _m_e_t_a _p_r_e_f_i_x).
  381.           oooouuuuttttppppuuuutttt----mmmmeeeettttaaaa ((((OOOOffffffff))))
  382.                If set to OOOOnnnn, readline will display characters with the
  383.                eighth bit set directly rather than as a meta-prefixed
  384.                escape sequence.
  385.           ccccoooommmmpppplllleeeettttiiiioooonnnn----qqqquuuueeeerrrryyyy----iiiitttteeeemmmmssss ((((111100000000))))
  386.                This determines when the user is queried about viewing
  387.                the number of possible completions generated by the
  388.                ppppoooossssssssiiiibbbblllleeee----ccccoooommmmpppplllleeeettttiiiioooonnnnssss command.  It may be set to any
  389.                integer value greater than or equal to zero.  If the
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 6/30/95)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  401.  
  402.  
  403.  
  404.                number of possible completions is greater than or equal
  405.                to the value of this variable, the user is asked
  406.                whether or not he wishes to view them; otherwise they
  407.                are simply listed on the terminal.
  408.           kkkkeeeeyyyymmmmaaaapppp ((((eeeemmmmaaaaccccssss))))
  409.                Set the current readline keymap.  The set of legal
  410.                keymap names is _e_m_a_c_s, _e_m_a_c_s-_s_t_a_n_d_a_r_d, _e_m_a_c_s-_m_e_t_a,
  411.                _e_m_a_c_s-_c_t_l_x, _v_i, _v_i-_m_o_v_e, _v_i-_c_o_m_m_a_n_d, and _v_i-_i_n_s_e_r_t.  _v_i
  412.                is equivalent to _v_i-_c_o_m_m_a_n_d; _e_m_a_c_s is equivalent to
  413.                _e_m_a_c_s-_s_t_a_n_d_a_r_d.  The default value is _e_m_a_c_s; the value
  414.                of eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee also affects the default keymap.
  415.           sssshhhhoooowwww----aaaallllllll----iiiiffff----aaaammmmbbbbiiiigggguuuuoooouuuussss ((((OOOOffffffff))))
  416.                This alters the default behavior of the completion
  417.                functions.  If set to oooonnnn, words which have more than
  418.                one possible completion cause the matches to be listed
  419.                immediately instead of ringing the bell.
  420.           eeeexxxxppppaaaannnndddd----ttttiiiillllddddeeee ((((OOOOffffffff))))
  421.                If set to oooonnnn, tilde expansion is performed when
  422.                readline attempts word completion.
  423.  
  424.         CCCCoooonnnnddddiiiittttiiiioooonnnnaaaallll CCCCoooonnnnssssttttrrrruuuuccccttttssss
  425.           Readline implements a facility similar in spirit to the
  426.           conditional compilation features of the C preprocessor which
  427.           allows key bindings and variable settings to be performed as
  428.           the result of tests.  There are three parser directives
  429.           used.
  430.  
  431.           $$$$iiiiffff  The $$$$iiiiffff construct allows bindings to be made based on
  432.                the editing mode, the terminal being used, or the
  433.                application using readline.  The text of the test
  434.                extends to the end of the line; no characters are
  435.                required to isolate it.
  436.  
  437.                mmmmooooddddeeee The mmmmooooddddeeee==== form of the $$$$iiiiffff directive is used to
  438.                     test whether readline is in emacs or vi mode.
  439.                     This may be used in conjunction with the sssseeeetttt
  440.                     kkkkeeeeyyyymmmmaaaapppp command, for instance, to set bindings in
  441.                     the _e_m_a_c_s-_s_t_a_n_d_a_r_d and _e_m_a_c_s-_c_t_l_x keymaps only if
  442.                     readline is starting out in emacs mode.
  443.  
  444.                tttteeeerrrrmmmm The tttteeeerrrrmmmm==== form may be used to include terminal-
  445.                     specific key bindings, perhaps to bind the key
  446.                     sequences output by the terminal's function keys.
  447.                     The word on the right side of the ==== is tested
  448.                     against the full name of the terminal and the
  449.                     portion of the terminal name before the first ----.
  450.                     This allows _s_u_n to match both _s_u_n and _s_u_n-_c_m_d, for
  451.                     instance.
  452.  
  453.                aaaapppppppplllliiiiccccaaaattttiiiioooonnnn
  454.                     The aaaapppppppplllliiiiccccaaaattttiiiioooonnnn construct is used to include
  455.                     application-specific settings.  Each program using
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 6/30/95)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  467.  
  468.  
  469.  
  470.                     the readline library sets the _a_p_p_l_i_c_a_t_i_o_n _n_a_m_e,
  471.                     and an initialization file can test for a
  472.                     particular value.  This could be used to bind key
  473.                     sequences to functions useful for a specific
  474.                     program.  For instance, the following command adds
  475.                     a key sequence that quotes the current or previous
  476.                     word in Bash:
  477.                     $$$$iiiiffff bash
  478.                     # Quote the current or previous word
  479.                     "\C-xq": "\eb\"\ef\""
  480.                     $$$$eeeennnnddddiiiiffff
  481.  
  482.           $$$$eeeennnnddddiiiiffff
  483.                This command, as you saw in the previous example,
  484.                terminates an $$$$iiiiffff command.
  485.  
  486.           $$$$eeeellllsssseeee
  487.                Commands in this branch of the $$$$iiiiffff directive are
  488.                executed if the test fails.
  489.  
  490.      EEEEDDDDIIIITTTTIIIINNNNGGGG CCCCOOOOMMMMMMMMAAAANNNNDDDDSSSS
  491.           The following is a list of the names of the commands and the
  492.           default key sequences to which they are bound.
  493.  
  494.         CCCCoooommmmmmmmaaaannnnddddssss ffffoooorrrr MMMMoooovvvviiiinnnngggg
  495.           bbbbeeeeggggiiiinnnnnnnniiiinnnngggg----ooooffff----lllliiiinnnneeee ((((CCCC----aaaa))))
  496.                Move to the start of the current line.
  497.           eeeennnndddd----ooooffff----lllliiiinnnneeee ((((CCCC----eeee))))
  498.                Move to the end of the line.
  499.           ffffoooorrrrwwwwaaaarrrrdddd----cccchhhhaaaarrrr ((((CCCC----ffff))))
  500.                Move forward a character.
  501.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----cccchhhhaaaarrrr ((((CCCC----bbbb))))
  502.                Move back a character.
  503.           ffffoooorrrrwwwwaaaarrrrdddd----wwwwoooorrrrdddd ((((MMMM----ffff))))
  504.                Move forward to the end of the next word.  Words are
  505.                composed of alphanumeric characters (letters and
  506.                digits).
  507.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----wwwwoooorrrrdddd ((((MMMM----bbbb))))
  508.                Move back to the start of this, or the previous, word.
  509.                Words are composed of alphanumeric characters (letters
  510.                and digits).
  511.           cccclllleeeeaaaarrrr----ssssccccrrrreeeeeeeennnn ((((CCCC----llll))))
  512.                Clear the screen leaving the current line at the top of
  513.                the screen.  With an argument, refresh the current line
  514.                without clearing the screen.
  515.           rrrreeeeddddrrrraaaawwww----ccccuuuurrrrrrrreeeennnntttt----lllliiiinnnneeee
  516.                Refresh the current line.  By default, this is unbound.
  517.  
  518.         CCCCoooommmmmmmmaaaannnnddddssss ffffoooorrrr MMMMaaaannnniiiippppuuuullllaaaattttiiiinnnngggg tttthhhheeee HHHHiiiissssttttoooorrrryyyy
  519.           aaaacccccccceeeepppptttt----lllliiiinnnneeee ((((NNNNeeeewwwwlllliiiinnnneeee,,,, RRRReeeettttuuuurrrrnnnn))))
  520.                Accept the line regardless of where the cursor is.  If
  521.                this line is non-empty, add it to the history list. If
  522.  
  523.  
  524.  
  525.      Page 8                                          (printed 6/30/95)
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  533.  
  534.  
  535.  
  536.                the line is a modified history line, then restore the
  537.                history line to its original state.
  538.           pppprrrreeeevvvviiiioooouuuussss----hhhhiiiissssttttoooorrrryyyy ((((CCCC----pppp))))
  539.                Fetch the previous command from the history list,
  540.                moving back in the list.
  541.           nnnneeeexxxxtttt----hhhhiiiissssttttoooorrrryyyy ((((CCCC----nnnn))))
  542.                Fetch the next command from the history list, moving
  543.                forward in the list.
  544.           bbbbeeeeggggiiiinnnnnnnniiiinnnngggg----ooooffff----hhhhiiiissssttttoooorrrryyyy ((((MMMM----<<<<))))
  545.                Move to the first line in the history.
  546.           eeeennnndddd----ooooffff----hhhhiiiissssttttoooorrrryyyy ((((MMMM---->>>>))))
  547.                Move to the end of the input history, i.e., the line
  548.                currently being entered.
  549.           rrrreeeevvvveeeerrrrsssseeee----sssseeeeaaaarrrrcccchhhh----hhhhiiiissssttttoooorrrryyyy ((((CCCC----rrrr))))
  550.                Search backward starting at the current line and moving
  551.                `up' through the history as necessary.  This is an
  552.                incremental search.
  553.           ffffoooorrrrwwwwaaaarrrrdddd----sssseeeeaaaarrrrcccchhhh----hhhhiiiissssttttoooorrrryyyy ((((CCCC----ssss))))
  554.                Search forward starting at the current line and moving
  555.                `down' through the history as necessary.  This is an
  556.                incremental search.
  557.           nnnnoooonnnn----iiiinnnnccccrrrreeeemmmmeeeennnnttttaaaallll----rrrreeeevvvveeeerrrrsssseeee----sssseeeeaaaarrrrcccchhhh----hhhhiiiissssttttoooorrrryyyy ((((MMMM----pppp))))
  558.                Search backward through the history starting at the
  559.                current line using a non-incremental search for a
  560.                string supplied by the user.
  561.           nnnnoooonnnn----iiiinnnnccccrrrreeeemmmmeeeennnnttttaaaallll----ffffoooorrrrwwwwaaaarrrrdddd----sssseeeeaaaarrrrcccchhhh----hhhhiiiissssttttoooorrrryyyy ((((MMMM----nnnn))))
  562.                Search forward through the history using a
  563.                non-incremental search for a string supplied by the
  564.                user.
  565.           hhhhiiiissssttttoooorrrryyyy----sssseeeeaaaarrrrcccchhhh----ffffoooorrrrwwwwaaaarrrrdddd
  566.                Search forward through the history for the string of
  567.                characters between the start of the current line and
  568.                the current point.  This is a non-incremental search.
  569.                By default, this command is unbound.
  570.           hhhhiiiissssttttoooorrrryyyy----sssseeeeaaaarrrrcccchhhh----bbbbaaaacccckkkkwwwwaaaarrrrdddd
  571.                Search backward through the history for the string of
  572.                characters between the start of the current line and
  573.                the current point.  This is a non-incremental search.
  574.                By default, this command is unbound.
  575.           yyyyaaaannnnkkkk----nnnntttthhhh----aaaarrrrgggg ((((MMMM----CCCC----yyyy))))
  576.                Insert the first argument to the previous command
  577.                (usually the second word on the previous line) at point
  578.                (the current cursor position).  With an argument _n,
  579.                insert the _nth word from the previous command (the
  580.                words in the previous command begin with word 0).  A
  581.                negative argument inserts the _nth word from the end of
  582.                the previous command.
  583.  
  584.         CCCCoooommmmmmmmaaaannnnddddssss ffffoooorrrr CCCChhhhaaaannnnggggiiiinnnngggg TTTTeeeexxxxtttt
  585.           ddddeeeelllleeeetttteeee----cccchhhhaaaarrrr ((((CCCC----dddd))))
  586.                Delete the character under the cursor.  If point is at
  587.                the beginning of the line, there are no characters in
  588.  
  589.  
  590.  
  591.      Page 9                                          (printed 6/30/95)
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  599.  
  600.  
  601.  
  602.                the line, and the last character typed was not CCCC----dddd,
  603.                then return EEEEOOOOFFFF.
  604.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----ddddeeeelllleeeetttteeee----cccchhhhaaaarrrr ((((RRRRuuuubbbboooouuuutttt))))
  605.                Delete the character behind the cursor.  When given a
  606.                numeric argument, save the deleted text on the
  607.                kill-ring.
  608.           qqqquuuuooootttteeeedddd----iiiinnnnsssseeeerrrrtttt ((((CCCC----qqqq,,,, CCCC----vvvv))))
  609.                Add the next character that you type to the line
  610.                verbatim.  This is how to insert characters like CCCC----qqqq,
  611.                for example.
  612.           ttttaaaabbbb----iiiinnnnsssseeeerrrrtttt ((((MMMM----TTTTAAAABBBB))))
  613.                Insert a tab character.
  614.           sssseeeellllffff----iiiinnnnsssseeeerrrrtttt ((((aaaa,,,, bbbb,,,, AAAA,,,, 1111,,,, !!!!,,,, ............))))
  615.                Insert the character typed.
  616.           ttttrrrraaaannnnssssppppoooosssseeee----cccchhhhaaaarrrrssss ((((CCCC----tttt))))
  617.                Drag the character before point forward over the
  618.                character at point.  Point moves forward as well.  If
  619.                point is at the end of the line, then transpose the two
  620.                characters before point.  Negative arguments don't
  621.                work.
  622.           ttttrrrraaaannnnssssppppoooosssseeee----wwwwoooorrrrddddssss ((((MMMM----tttt))))
  623.                Drag the word behind the cursor past the word in front
  624.                of the cursor moving the cursor over that word as well.
  625.           uuuuppppccccaaaasssseeee----wwwwoooorrrrdddd ((((MMMM----uuuu))))
  626.                Uppercase the current (or following) word.  With a
  627.                negative argument, do the previous word, but do not
  628.                move point.
  629.           ddddoooowwwwnnnnccccaaaasssseeee----wwwwoooorrrrdddd ((((MMMM----llll))))
  630.                Lowercase the current (or following) word.  With a
  631.                negative argument, do the previous word, but do not
  632.                move point.
  633.           ccccaaaappppiiiittttaaaalllliiiizzzzeeee----wwwwoooorrrrdddd ((((MMMM----cccc))))
  634.                Capitalize the current (or following) word.  With a
  635.                negative argument, do the previous word, but do not
  636.                move point.
  637.  
  638.         KKKKiiiilllllllliiiinnnngggg aaaannnndddd YYYYaaaannnnkkkkiiiinnnngggg
  639.           kkkkiiiillllllll----lllliiiinnnneeee ((((CCCC----kkkk))))
  640.                Kill the text from the current cursor position to the
  641.                end of the line.
  642.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----kkkkiiiillllllll----lllliiiinnnneeee ((((CCCC----xxxx RRRRuuuubbbboooouuuutttt))))
  643.                Kill backward to the beginning of the line.
  644.           uuuunnnniiiixxxx----lllliiiinnnneeee----ddddiiiissssccccaaaarrrrdddd ((((CCCC----uuuu))))
  645.                Kill backward from point to the beginning of the line.
  646.           kkkkiiiillllllll----wwwwhhhhoooolllleeee----lllliiiinnnneeee
  647.                Kill all characters on the current line, no matter
  648.                where the cursor is.  By default, this is unbound.
  649.           kkkkiiiillllllll----wwwwoooorrrrdddd ((((MMMM----dddd))))
  650.                Kill from the cursor to the end of the current word, or
  651.                if between words, to the end of the next word.  Word
  652.                boundaries are the same as those used by ffffoooorrrrwwwwaaaarrrrdddd----wwwwoooorrrrdddd.
  653.           bbbbaaaacccckkkkwwwwaaaarrrrdddd----kkkkiiiillllllll----wwwwoooorrrrdddd ((((MMMM----RRRRuuuubbbboooouuuutttt))))
  654.  
  655.  
  656.  
  657.      Page 10                                         (printed 6/30/95)
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  665.  
  666.  
  667.  
  668.                Kill the word behind the cursor.  Word boundaries are
  669.                the same as those used by bbbbaaaacccckkkkwwwwaaaarrrrdddd----wwwwoooorrrrdddd.
  670.           uuuunnnniiiixxxx----wwwwoooorrrrdddd----rrrruuuubbbboooouuuutttt ((((CCCC----wwww))))
  671.                Kill the word behind the cursor, using white space as a
  672.                word boundary.  The word boundaries are different from
  673.                bbbbaaaacccckkkkwwwwaaaarrrrdddd----kkkkiiiillllllll----wwwwoooorrrrdddd.
  674.           ddddeeeelllleeeetttteeee----hhhhoooorrrriiiizzzzoooonnnnttttaaaallll----ssssppppaaaacccceeee
  675.                Delete all spaces and tabs around point.  By default,
  676.                this is unbound.
  677.           yyyyaaaannnnkkkk ((((CCCC----yyyy))))
  678.                Yank the top of the kill ring into the buffer at the
  679.                cursor.
  680.           yyyyaaaannnnkkkk----ppppoooopppp ((((MMMM----yyyy))))
  681.                Rotate the kill-ring, and yank the new top.  Only works
  682.                following yyyyaaaannnnkkkk or yyyyaaaannnnkkkk----ppppoooopppp.
  683.  
  684.         NNNNuuuummmmeeeerrrriiiicccc AAAArrrrgggguuuummmmeeeennnnttttssss
  685.           ddddiiiiggggiiiitttt----aaaarrrrgggguuuummmmeeeennnntttt ((((MMMM----0000,,,, MMMM----1111,,,, ............,,,, MMMM--------))))
  686.                Add this digit to the argument already accumulating, or
  687.                start a new argument.  M-- starts a negative argument.
  688.           uuuunnnniiiivvvveeeerrrrssssaaaallll----aaaarrrrgggguuuummmmeeeennnntttt
  689.                Each time this is executed, the argument count is
  690.                multiplied by four.  The argument count is initially
  691.                one, so executing this function the first time makes
  692.                the argument count four.  By default, this is not bound
  693.                to a key.
  694.  
  695.         CCCCoooommmmpppplllleeeettttiiiinnnngggg
  696.           ccccoooommmmpppplllleeeetttteeee ((((TTTTAAAABBBB))))
  697.                Attempt to perform completion on the text before point.
  698.                The actual completion performed is application-
  699.                specific.  BBBBaaaasssshhhh, for instance, attempts completion
  700.                treating the text as a variable (if the text begins
  701.                with $$$$), username (if the text begins with ~~~~), hostname
  702.                (if the text begins with @@@@), or command (including
  703.                aliases and functions) in turn.  If none of these
  704.                produces a match, filename completion is attempted.
  705.                GGGGddddbbbb, on the other hand, allows completion of program
  706.                functions and variables, and only attempts filename
  707.                completion under certain circumstances.
  708.           ppppoooossssssssiiiibbbblllleeee----ccccoooommmmpppplllleeeettttiiiioooonnnnssss ((((MMMM----????))))
  709.                List the possible completions of the text before point.
  710.           iiiinnnnsssseeeerrrrtttt----ccccoooommmmpppplllleeeettttiiiioooonnnnssss
  711.                Insert all completions of the text before point that
  712.                would have been generated by ppppoooossssssssiiiibbbblllleeee----ccccoooommmmpppplllleeeettttiiiioooonnnnssss.  By
  713.                default, this is not bound to a key.
  714.  
  715.         KKKKeeeeyyyybbbbooooaaaarrrrdddd MMMMaaaaccccrrrroooossss
  716.           ssssttttaaaarrrrtttt----kkkkbbbbdddd----mmmmaaaaccccrrrroooo ((((CCCC----xxxx (((())))
  717.                Begin saving the characters typed into the current
  718.                keyboard macro.
  719.           eeeennnndddd----kkkkbbbbdddd----mmmmaaaaccccrrrroooo ((((CCCC----xxxx ))))))))
  720.  
  721.  
  722.  
  723.      Page 11                                         (printed 6/30/95)
  724.  
  725.  
  726.  
  727.  
  728.  
  729.  
  730.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  731.  
  732.  
  733.  
  734.                Stop saving the characters typed into the current
  735.                keyboard macro and save the definition.
  736.           ccccaaaallllllll----llllaaaasssstttt----kkkkbbbbdddd----mmmmaaaaccccrrrroooo ((((CCCC----xxxx eeee))))
  737.                Re-execute the last keyboard macro defined, by making
  738.                the characters in the macro appear as if typed at the
  739.                keyboard.
  740.  
  741.         MMMMiiiisssscccceeeellllllllaaaannnneeeeoooouuuussss
  742.           rrrreeee----rrrreeeeaaaadddd----iiiinnnniiiitttt----ffffiiiilllleeee ((((CCCC----xxxx CCCC----rrrr))))
  743.                Read in the contents of your init file, and incorporate
  744.                any bindings or variable assignments found there.
  745.           aaaabbbboooorrrrtttt ((((CCCC----gggg))))
  746.                Abort the current editing command and ring the
  747.                terminal's bell (subject to the setting of bbbbeeeellllllll----ssssttttyyyylllleeee).
  748.           ddddoooo----uuuuppppppppeeeerrrrccccaaaasssseeee----vvvveeeerrrrssssiiiioooonnnn ((((MMMM----aaaa,,,, MMMM----bbbb,,,, ............))))
  749.                Run the command that is bound to the corresponding
  750.                uppercase character.
  751.           pppprrrreeeeffffiiiixxxx----mmmmeeeettttaaaa ((((EEEESSSSCCCC))))
  752.                Metafy the next character typed.  EEEESSSSCCCC ffff is equivalent
  753.                to MMMMeeeettttaaaa----ffff.
  754.           uuuunnnnddddoooo ((((CCCC----____,,,, CCCC----xxxx CCCC----uuuu))))
  755.                Incremental undo, separately remembered for each line.
  756.           rrrreeeevvvveeeerrrrtttt----lllliiiinnnneeee ((((MMMM----rrrr))))
  757.                Undo all changes made to this line.  This is like
  758.                typing the uuuunnnnddddoooo command enough times to return the line
  759.                to its initial state.
  760.           ttttiiiillllddddeeee----eeeexxxxppppaaaannnndddd ((((MMMM----~~~~))))
  761.                Perform tilde expansion on the current word.
  762.           dddduuuummmmpppp----ffffuuuunnnnccccttttiiiioooonnnnssss
  763.                Print all of the functions and their key bindings to
  764.                the readline output stream.  If a numeric argument is
  765.                supplied, the output is formatted in such a way that it
  766.                can be made part of an _i_n_p_u_t_r_c file.
  767.           eeeemmmmaaaaccccssss----eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee ((((CCCC----eeee))))
  768.                When in vvvviiii editing mode, this causes a switch to eeeemmmmaaaaccccssss
  769.                editing mode.
  770.           vvvviiii----eeeeddddiiiittttiiiinnnngggg----mmmmooooddddeeee ((((MMMM----CCCC----jjjj))))
  771.                When in eeeemmmmaaaaccccssss editing mode, this causes a switch to vvvviiii
  772.                editing mode.
  773.  
  774.      DDDDEEEEFFFFAAAAUUUULLLLTTTT KKKKEEEEYYYY BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
  775.           The following is a list of the default emacs and vi
  776.           bindings.  Characters with the 8th bit set are written as
  777.           M-<character>, and are referred to as _m_e_t_a_f_i_e_d characters.
  778.           The printable ASCII characters not mentioned in the list of
  779.           emacs standard bindings are bound to the _s_e_l_f-_i_n_s_e_r_t
  780.           function, which just inserts the given character into the
  781.           input line.  In vi insertion mode, all characters not
  782.           specifically mentioned are bound to _s_e_l_f-_i_n_s_e_r_t.  Characters
  783.           assigned to signal generation by _s_t_t_y(1) or the terminal
  784.           driver, such as C-Z or C-C, retain that function.  Upper and
  785.           lower case _m_e_t_a_f_i_e_d characters are bound to the same
  786.  
  787.  
  788.  
  789.      Page 12                                         (printed 6/30/95)
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  797.  
  798.  
  799.  
  800.           function in the emacs mode meta keymap.  The remaining
  801.           characters are unbound, which causes readline to ring the
  802.           bell (subject to the setting of the bbbbeeeellllllll----ssssttttyyyylllleeee variable).
  803.  
  804.         EEEEmmmmaaaaccccssss MMMMooooddddeeee
  805.                 Emacs Standard bindings
  806.  
  807.                 "C-A"                    ->  beginning-of-line
  808.                 "C-B"                    ->  backward-char
  809.                 "C-D"                    ->  delete-char
  810.                 "C-E"                    ->  end-of-line
  811.                 "C-F"                    ->  forward-char
  812.                 "C-G"                    ->  abort
  813.                 "C-H"                    ->  backward-delete-char
  814.                 "C-I"                    ->  complete
  815.                 "C-J"                    ->  accept-line
  816.                 "C-K"                    ->  kill-line
  817.                 "C-L"                    ->  clear-screen
  818.                 "C-M"                    ->  accept-line
  819.                 "C-N"                    ->  next-history
  820.                 "C-P"                    ->  previous-history
  821.                 "C-Q"                    ->  quoted-insert
  822.                 "C-R"                    ->  reverse-search-history
  823.                 "C-S"                    ->  forward-search-history
  824.                 "C-T"                    ->  transpose-chars
  825.                 "C-U"                    ->  unix-line-discard
  826.                 "C-V"                    ->  quoted-insert
  827.                 "C-W"                    ->  unix-word-rubout
  828.                 "C-Y"                    ->  yank
  829.                 "C-_"                    ->  undo
  830.                 " " to "/"               ->  self-insert
  831.                 "0"  to "9"              ->  self-insert
  832.                 ":"  to "~"              ->  self-insert
  833.                 "C-?"                    ->  backward-delete-char
  834.  
  835.                 Emacs Meta bindings
  836.  
  837.                 "M-C-H"                  ->  backward-kill-word
  838.                 "M-C-I"                  ->  tab-insert
  839.                 "M-C-J"                  ->  vi-editing-mode
  840.                 "M-C-M"                  ->  vi-editing-mode
  841.                 "M-C-R"                  ->  revert-line
  842.                 "M-C-Y"                  ->  yank-nth-arg
  843.                 "M-C-["                  ->  complete
  844.                 "M-&"                    ->  tilde-expand
  845.                 "M--"                    ->  digit-argument
  846.                 "M-0"                    ->  digit-argument
  847.                 "M-1"                    ->  digit-argument
  848.                 "M-2"                    ->  digit-argument
  849.                 "M-3"                    ->  digit-argument
  850.                 "M-4"                    ->  digit-argument
  851.                 "M-5"                    ->  digit-argument
  852.  
  853.  
  854.  
  855.      Page 13                                         (printed 6/30/95)
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  863.  
  864.  
  865.  
  866.                 "M-6"                    ->  digit-argument
  867.                 "M-7"                    ->  digit-argument
  868.                 "M-8"                    ->  digit-argument
  869.                 "M-9"                    ->  digit-argument
  870.                 "M-<"                    ->  beginning-of-history
  871.                 "M->"                    ->  end-of-history
  872.                 "M-?"                    ->  possible-completions
  873.                 "M-B"                    ->  backward-word
  874.                 "M-C"                    ->  capitalize-word
  875.                 "M-D"                    ->  kill-word
  876.                 "M-F"                    ->  forward-word
  877.                 "M-L"                    ->  downcase-word
  878.                 "M-N"                    ->  non-incremental-forward-search-history
  879.                 "M-O"                    ->  arrow-key-prefix
  880.                 "M-P"                    ->  non-incremental-reverse-search-history
  881.                 "M-R"                    ->  revert-line
  882.                 "M-T"                    ->  transpose-words
  883.                 "M-U"                    ->  upcase-word
  884.                 "M-Y"                    ->  yank-pop
  885.                 "M-C-Y"                  ->  yank-nth-arg
  886.                 "M-C-?"                  ->  backward-delete-word
  887.  
  888.                 Emacs Control-X bindings
  889.  
  890.                 "C-XC-G"                 ->  abort
  891.                 "C-XC-R"                 ->  re-read-init-file
  892.                 "C-XC-U"                 ->  undo
  893.                 "C-X("                   ->  start-kbd-macro
  894.                 "C-X)"                   ->  end-kbd-macro
  895.                 "C-Xe"                   ->  call-last-kbd-macro
  896.                 "C-XC-?"                 ->  backward-kill-line
  897.  
  898.  
  899.         VVVVIIII MMMMooooddddeeee bbbbiiiinnnnddddiiiinnnnggggssss
  900.                 VI Insert Mode functions
  901.  
  902.                 "C-D"                    ->  vi-eof-maybe
  903.                 "C-H"                    ->  backward-delete-char
  904.                 "C-I"                    ->  complete
  905.                 "C-J"                    ->  accept-line
  906.                 "C-K"                    ->  kill-line
  907.                 "C-L"                    ->  clear-screen
  908.                 "C-M"                    ->  accept-line
  909.                 "C-N"                    ->  next-history
  910.                 "C-P"                    ->  previous-history
  911.                 "C-Q"                    ->  quoted-insert
  912.                 "C-R"                    ->  reverse-search-history
  913.                 "C-S"                    ->  forward-search-history
  914.                 "C-T"                    ->  transpose-chars
  915.                 "C-U"                    ->  unix-line-discard
  916.                 "C-V"                    ->  quoted-insert
  917.                 "C-W"                    ->  unix-word-rubout
  918.  
  919.  
  920.  
  921.      Page 14                                         (printed 6/30/95)
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  929.  
  930.  
  931.  
  932.                 "C-Y"                    ->  yank
  933.                 "C-["                    ->  vi-movement-mode
  934.                 " " to "~"               ->  self-insert
  935.                 "C-?"                    ->  backward-delete-char
  936.  
  937.                 VI Command Mode functions
  938.  
  939.                 "C-D"                    ->  vi-eof-maybe
  940.                 "C-E"                    ->  emacs-editing-mode
  941.                 "C-G"                    ->  abort
  942.                 "C-H"                    ->  backward-char
  943.                 "C-J"                    ->  accept-line
  944.                 "C-K"                    ->  kill-line
  945.                 "C-L"                    ->  clear-screen
  946.                 "C-M"                    ->  accept-line
  947.                 "C-N"                    ->  next-history
  948.                 "C-P"                    ->  previous-history
  949.                 "C-Q"                    ->  quoted-insert
  950.                 "C-R"                    ->  reverse-search-history
  951.                 "C-S"                    ->  forward-search-history
  952.                 "C-T"                    ->  transpose-chars
  953.                 "C-U"                    ->  unix-line-discard
  954.                 "C-V"                    ->  quoted-insert
  955.                 "C-W"                    ->  unix-word-rubout
  956.                 "C-Y"                    ->  yank
  957.                 "C-["                    ->  abort
  958.                 " "                      ->  forward-char
  959.                 "#"                      ->  vi-comment
  960.                 "$"                      ->  end-of-line
  961.                 "%"                      ->  vi-match
  962.                 "&"                      ->  vi-tilde-expand
  963.                 "*"                      ->  vi-complete
  964.                 "+"                      ->  down-history
  965.                 ","                      ->  vi-char-search
  966.                 "-"                      ->  previous-history
  967.                 "."                      ->  vi-redo
  968.                 "/"                      ->  vi-search
  969.                 "0"                      ->  beginning-of-line
  970.                 "1" to "9"               ->  vi-arg-digit
  971.                 ";"                      ->  vi-char-search
  972.                 "="                      ->  vi-complete
  973.                 "?"                      ->  vi-search
  974.                 "@"                      ->  is undefined
  975.                 "A"                      ->  vi-append-eol
  976.                 "B"                      ->  vi-prev-word
  977.                 "C"                      ->  vi-change-to
  978.                 "D"                      ->  vi-delete-to
  979.                 "E"                      ->  vi-end-word
  980.                 "F"                      ->  vi-char-search
  981.                 "I"                      ->  vi-insert-beg
  982.                 "N"                      ->  vi-search-again
  983.                 "P"                      ->  vi-put
  984.  
  985.  
  986.  
  987.      Page 15                                         (printed 6/30/95)
  988.  
  989.  
  990.  
  991.  
  992.  
  993.  
  994.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  995.  
  996.  
  997.  
  998.                 "R"                      ->  vi-replace
  999.                 "S"                      ->  vi-subst
  1000.                 "T"                      ->  vi-char-search
  1001.                 "U"                      ->  revert-line
  1002.                 "W"                      ->  vi-next-word
  1003.                 "X"                      ->  backward-delete-char
  1004.                 "Y"                      ->  vi-yank-to
  1005.                 "\"                      ->  vi-complete
  1006.                 "^"                      ->  vi-first-print
  1007.                 "_"                      ->  vi-yank-arg
  1008.                 "a"                      ->  vi-append-mode
  1009.                 "b"                      ->  vi-prev-word
  1010.                 "c"                      ->  vi-change-to
  1011.                 "d"                      ->  vi-delete-to
  1012.                 "e"                      ->  vi-end-word
  1013.                 "f"                      ->  vi-char-search
  1014.                 "h"                      ->  backward-char
  1015.                 "i"                      ->  vi-insertion-mode
  1016.                 "j"                      ->  next-history
  1017.                 "k"                      ->  prev-history
  1018.                 "l"                      ->  forward-char
  1019.                 "n"                      ->  vi-search-again
  1020.                 "r"                      ->  vi-change-char
  1021.                 "s"                      ->  vi-subst
  1022.                 "t"                      ->  vi-char-search
  1023.                 "u"                      ->  undo
  1024.                 "w"                      ->  vi-next-word
  1025.                 "x"                      ->  vi-delete
  1026.                 "y"                      ->  vi-yank-to
  1027.                 "|"                      ->  vi-column
  1028.                 "~"                      ->  vi-change-case
  1029.  
  1030.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  1031.           _T_h_e _G_n_u _R_e_a_d_l_i_n_e _L_i_b_r_a_r_y, Brian Fox
  1032.           _T_h_e _G_n_u _H_i_s_t_o_r_y _L_i_b_r_a_r_y, Brian Fox
  1033.           _b_a_s_h(1)
  1034.  
  1035.      FFFFIIIILLLLEEEESSSS
  1036.           ~/._i_n_p_u_t_r_c
  1037.                Individual rrrreeeeaaaaddddlllliiiinnnneeee initialization file
  1038.  
  1039.      AAAAUUUUTTTTHHHHOOOORRRRSSSS
  1040.                Brian Fox, Free Software Foundation (primary author)
  1041.                bfox@ai.MIT.Edu
  1042.  
  1043.                Chet Ramey, Case Western Reserve University
  1044.                chet@ins.CWRU.Edu
  1045.  
  1046.      BBBBUUUUGGGG RRRREEEEPPPPOOOORRRRTTTTSSSS
  1047.           If you find a bug in rrrreeeeaaaaddddlllliiiinnnneeee,,,, you should report it.  But
  1048.           first, you should make sure that it really is a bug, and
  1049.           that it appears in the latest version of the rrrreeeeaaaaddddlllliiiinnnneeee
  1050.  
  1051.  
  1052.  
  1053.      Page 16                                         (printed 6/30/95)
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.      RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))            GGGGNNNNUUUU ((((1111999999994444 JJJJuuuunnnneeee 11113333))))             RRRREEEEAAAADDDDLLLLIIIINNNNEEEE((((3333))))
  1061.  
  1062.  
  1063.  
  1064.           library that you have.
  1065.  
  1066.           Once you have determined that a bug actually exists, mail a
  1067.           bug report to _b_a_s_h-_m_a_i_n_t_a_i_n_e_r_s@_p_r_e_p._a_i._M_I_T._E_d_u.  If you have
  1068.           a fix, you are welcome to mail that as well!  Suggestions
  1069.           and `philosophical' bug reports may be mailed to _b_u_g-
  1070.           _b_a_s_h@_p_r_e_p._a_i._M_I_T._E_d_u or posted to the Usenet newsgroup
  1071.           ggggnnnnuuuu....bbbbaaaasssshhhh....bbbbuuuugggg.
  1072.  
  1073.           Comments and bug reports concerning this manual page should
  1074.           be directed to _c_h_e_t@_i_n_s._C_W_R_U._E_d_u.
  1075.  
  1076.      BBBBUUUUGGGGSSSS
  1077.           It's too big and too slow.
  1078.  
  1079.  
  1080.  
  1081.  
  1082.  
  1083.  
  1084.  
  1085.  
  1086.  
  1087.  
  1088.  
  1089.  
  1090.  
  1091.  
  1092.  
  1093.  
  1094.  
  1095.  
  1096.  
  1097.  
  1098.  
  1099.  
  1100.  
  1101.  
  1102.  
  1103.  
  1104.  
  1105.  
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.  
  1119.      Page 17                                         (printed 6/30/95)
  1120.  
  1121.  
  1122.  
  1123.